/*

Copyright (c) 2016, Robin Raymond
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.

*/

#pragma once

#include <zsLib/eventing/tool/internal/zsLib_eventing_tool_IDLCompiler.h>

#include <list>

namespace zsLib
{
  namespace eventing
  {
    namespace tool
    {
      namespace internal
      {
        

        //---------------------------------------------------------------------
        //---------------------------------------------------------------------
        //---------------------------------------------------------------------
        //---------------------------------------------------------------------
        //
        // GenerateHelper
        //

        struct GenerateHelper : public IDLCompiler
        {
          typedef std::list<String> StringList;

          static String getDashedComment(const String &indent);

          static String getDocumentation(
                                         const String &linePrefix,
                                         ContextPtr context,
                                         size_t maxLineLength
                                         );

          static void insertFirst(
                                  std::stringstream &ss,
                                  bool &first
                                 );
          static void insertLast(
                                 std::stringstream &ss,
                                 bool &first
                                 );
          static void insertBlob(
                                 std::stringstream &ss,
                                 const String &indentStr,
                                 const char *blob,
                                 bool blankLineHasIndent = false
                                 );

          static bool isBuiltInType(TypePtr type);

          static bool hasOnlyStaticMethods(StructPtr structObj);
          static bool hasEventHandlers(StructPtr structObj);

          static bool isConstructable(StructPtr structObj);
          static bool needsDefaultConstructor(StructPtr structObj);
          static bool needsDefaultConstructor(TemplatedStructTypePtr templateObj);

          static String getBasicTypeString(IEventingTypes::PredefinedTypedefs type);
          static String getBasicTypeString(BasicTypePtr type);

          static String getConverstionNameString(IEventingTypes::PredefinedTypedefs type);
          static String getConverstionNameString(BasicTypePtr type);

          static bool isSafeIntType(IEventingTypes::PredefinedTypedefs type);
          static bool isSafeIntType(BasicTypePtr type);

          static bool isFloat(IEventingTypes::PredefinedTypedefs type);
          static bool isFloat(BasicTypePtr type);

          static bool isDefaultExceptionType(TypePtr type);

          static StringList getAllExceptions(const char *prefix) noexcept;
        };

      } // namespace internal
    } // namespace tool
  } // namespace eventing
} // namespace zsLib
